Skip to content

Add Produktly source docs #7773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

Desentso
Copy link

Proposed changes

Merge timing

  • Merge once the Produktly source has been approved and is live on the integration catalog

Related issues (optional)

  • N/A

@Desentso Desentso requested a review from a team as a code owner July 17, 2025 18:31
@Desentso Desentso requested a review from stayseesong July 17, 2025 18:31
title: Produktly Source
---

[Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an all-in-one platform for product-led growth. We provide a suite tools such as product tours, checklists, feedback widgets, NPS, announcements, changelogs, roadmaps and much more, that drive growth by helping you improving onboarding, effectively communicate with customers and by helping you gather actionable feedback.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an all-in-one platform for product-led growth. We provide a suite tools such as product tours, checklists, feedback widgets, NPS, announcements, changelogs, roadmaps and much more, that drive growth by helping you improving onboarding, effectively communicate with customers and by helping you gather actionable feedback.
[Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an all-in-one platform for product-led growth. Produktly provides a suite of tools such as product tours, checklists, feedback widgets, NPS, announcements, changelogs, roadmaps and much more, that drive growth by helping you improve onboarding, effectively communicate with customers, and by helping you gather actionable feedback.


[Produktly](https://produktly/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} is an all-in-one platform for product-led growth. We provide a suite tools such as product tours, checklists, feedback widgets, NPS, announcements, changelogs, roadmaps and much more, that drive growth by helping you improving onboarding, effectively communicate with customers and by helping you gather actionable feedback.

This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but can also federate the exported data into your other enabled Segment Destinations.
This is an [Event Cloud Source](/docs/sources/#event-cloud-sources) which enables you to export data into your Segment warehouse, and also federate the exported data into your other enabled Segment Destinations.

## Getting started

1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
2. Search for "Produktly" in the Sources Catalog, select Produktly, and click **Add Source**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Search for "Produktly" in the Sources Catalog, select Produktly, and click **Add Source**.
2. Search for *Produktly* in the Sources Catalog, select **Produktly**, and click **Add Source**.


1. From your workspace's [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank”} click **Add Source**.
2. Search for "Produktly" in the Sources Catalog, select Produktly, and click **Add Source**.
3. On the next screen, give the Source a name configure any other settings.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. On the next screen, give the Source a name configure any other settings.
3. Give the Source a name and configure any other settings.

- The name is used as a label in the Segment app, and Segment creates a related schema name in your warehouse. The name can be anything, but we recommend using something that reflects the source itself and distinguishes amongst your environments (eg. SourceName_Prod, SourceName_Staging, SourceName_Dev).

4. Click **Add Source** to save your settings.
5. Copy the Write key from the Segment UI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
5. Copy the Write key from the Segment UI.
5. Copy the Write key.


## Event Properties

The table below list the properties included in the events listed above.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The table below list the properties included in the events listed above.
See the list of event properties.

Comment on lines +60 to +144
#### Tour Available

| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |

#### Tour Start

| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |

#### Tour Auto Start

| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |

#### Tour Continue

| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |

#### Tour Finish

| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |

#### Tour Step

| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
| `metadata` | Object that contains `stepIndex` of the tour that was viewed, and `type` either "next" or "previous" telling whether the user moved forward or backwards |

#### Checklist Step Completed

| Property Name | Description |
| ----------------- | ------------------------ |
| `checklist_id` | Id of the checklist |
| `metadata` | Object that contains `stepId` of the checklist that was completed |

#### Checklist Finished

| Property Name | Description |
| ----------------- | ------------------------ |
| `checklist_id` | Id of the checklist |

#### Smart Tip Available

| Property Name | Description |
| ----------------- | ------------------------ |
| `smart_tip_id` | Id of the smart tip |

#### Smart Tip Open

| Property Name | Description |
| ----------------- | ------------------------ |
| `smart_tip_id` | Id of the smart tip |

#### Announcement Shown

| Property Name | Description |
| ----------------- | ------------------------ |
| `announcement_id` | Id of the announcement |

#### Announcement Action Clicked

| Property Name | Description |
| ----------------- | ------------------------ |
| `announcement_id` | Id of the announcement |

#### Announcement Closed

| Property Name | Description |
| ----------------- | ------------------------ |
| `announcement_id` | Id of the announcement |

#### Nps Widget Shown

| Property Name | Description |
| ----------------- | ------------------------ |
| `nps_widget_id` | Id of the NPS widget |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Tour Available
| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
#### Tour Start
| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
#### Tour Auto Start
| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
#### Tour Continue
| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
#### Tour Finish
| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
#### Tour Step
| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
| `metadata` | Object that contains `stepIndex` of the tour that was viewed, and `type` either "next" or "previous" telling whether the user moved forward or backwards |
#### Checklist Step Completed
| Property Name | Description |
| ----------------- | ------------------------ |
| `checklist_id` | Id of the checklist |
| `metadata` | Object that contains `stepId` of the checklist that was completed |
#### Checklist Finished
| Property Name | Description |
| ----------------- | ------------------------ |
| `checklist_id` | Id of the checklist |
#### Smart Tip Available
| Property Name | Description |
| ----------------- | ------------------------ |
| `smart_tip_id` | Id of the smart tip |
#### Smart Tip Open
| Property Name | Description |
| ----------------- | ------------------------ |
| `smart_tip_id` | Id of the smart tip |
#### Announcement Shown
| Property Name | Description |
| ----------------- | ------------------------ |
| `announcement_id` | Id of the announcement |
#### Announcement Action Clicked
| Property Name | Description |
| ----------------- | ------------------------ |
| `announcement_id` | Id of the announcement |
#### Announcement Closed
| Property Name | Description |
| ----------------- | ------------------------ |
| `announcement_id` | Id of the announcement |
#### Nps Widget Shown
| Property Name | Description |
| ----------------- | ------------------------ |
| `nps_widget_id` | Id of the NPS widget |
| Property Name | Description |
| ----------------- | ------------------------ |
| `tour_id` | Id of the tour |
| `metadata` | (For the `Tour Step` event) Object that contains `stepIndex` of the tour that was viewed, and `type` either "next" or "previous" telling whether the user moved forward or backwards |
| `checklist_id` | Id of the checklist |
| `metadata` | (For the `Checklist Step Completed` event) Object that contains `stepId` of the checklist that was completed |
| `smart_tip_id` | Id of the smart tip |
| `announcement_id` | Id of the announcement |
| `nps_widget_id` | Id of the NPS widget |




## Adding Destinations
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Adding Destinations
## Adding destinations


## Adding Destinations

Now that your Source is set up, you can connect it with Destinations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Now that your Source is set up, you can connect it with Destinations.
Once your Source is set up, you can connect it with Destinations.


Now that your Source is set up, you can connect it with Destinations.

Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Log into your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.
Log in to your downstream tools and check to see that your events appear as expected, and that they contain all of the properties you expect. If your events and properties don’t appear, check the [Event Delivery](/docs/connections/event-delivery/) tool, and refer to the Destination docs for each tool for troubleshooting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants